<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Dimble's Playground » \RWebUser</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Dimble's Playground</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Auth.html"><i class="icon-folder-open"></i> Auth</a></li>
<li><a href="../packages/Database.html"><i class="icon-folder-open"></i> Database</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Infraestructure.html"><i class="icon-folder-open"></i> Infraestructure</a></li>
<li><a href="../packages/Rights.html"><i class="icon-folder-open"></i> Rights</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">418</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<div class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
</div>
<ul class="side-nav nav nav-list"><li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_afterLogin" title="afterLogin() :: Actions to be taken after logging in."><span class="description">Actions to be taken after logging in.</span><pre>afterLogin()</pre></a></li>
<li class="method public "><a href="#method_checkAccess" title="checkAccess() :: Performs access check for this user."><span class="description">Performs access check for this user.</span><pre>checkAccess()</pre></a></li>
<li class="method public "><a href="#method_getIsSuperuser" title="getIsSuperuser() :: "><span class="description">getIsSuperuser()
        </span><pre>getIsSuperuser()</pre></a></li>
<li class="method public "><a href="#method_getRightsReturnUrl" title="getRightsReturnUrl() :: Returns the URL that the user should be redirected to
after updating an authorization item."><span class="description">Returns the URL that the user should be redirected to
after updating an authorization item.</span><pre>getRightsReturnUrl()</pre></a></li>
<li class="method public "><a href="#method_setIsSuperuser" title="setIsSuperuser() :: "><span class="description">setIsSuperuser()
        </span><pre>setIsSuperuser()</pre></a></li>
<li class="method public "><a href="#method_setRightsReturnUrl" title="setRightsReturnUrl() :: "><span class="description">setRightsReturnUrl()
        </span><pre>setRightsReturnUrl()</pre></a></li>
</ul>
</li></ul>
</div>
<div class="span8">
<a id="\RWebUser"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/RWebUser.html">RWebUser</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Rights web user class file.</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:cniska@live.com">Christoffer Niska</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright &amp;copy; 2010 Christoffer Niska</td>
</tr>
<tr>
<th>since</th>
<td>0.5</td>
</tr>
<tr>
<th>package</th>
<td><a href="../packages/Rights.html">Rights</a></td>
</tr>
</table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method_afterLogin"></a><div class="element clickable method public method_afterLogin" data-toggle="collapse" data-target=".method_afterLogin .collapse" title="public">
<h2>Actions to be taken after logging in.</h2>
<pre>afterLogin(boolean $fromCookie) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description">Overloads the parent method in order to mark superusers.</div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$fromCookie</h4>
<code>boolean</code><p>whether the login is based on cookie.</p></div>
</div></div>
</div>
<a id="method_checkAccess"></a><div class="element clickable method public method_checkAccess" data-toggle="collapse" data-target=".method_checkAccess .collapse" title="public">
<h2>Performs access check for this user.</h2>
<pre>checkAccess(string $operation, array $params<code> = array()</code>, boolean $allowCaching<code> = true</code>) : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description">Overloads the parent method in order to allow superusers access implicitly.</div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$operation</h4>
<code>string</code><p>the name of the operation that need access check.</p></div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code><p>name-value pairs that would be passed to business rules associated
with the tasks and roles assigned to the user.</p></div>
<div class="subelement argument">
<h4>$allowCaching</h4>
<code>boolean</code><p>whether to allow caching the result of access checki.
This parameter has been available since version 1.0.5. When this parameter
is true (default), if the access check of an operation was performed before,
its result will be directly returned when calling this method to check the same operation.
If this parameter is false, this method will always call {@link CAuthManager::checkAccess}
to obtain the up-to-date access result. Note that this caching is effective
only within the same request.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>whether the operations can be performed by this user.</div>
</div></div>
</div>
<a id="method_getIsSuperuser"></a><div class="element clickable method public method_getIsSuperuser" data-toggle="collapse" data-target=".method_getIsSuperuser .collapse" title="public">
<h2>getIsSuperuser()
        </h2>
<pre>getIsSuperuser() : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>whether the user is a superuser.</div>
</div></div>
</div>
<a id="method_getRightsReturnUrl"></a><div class="element clickable method public method_getRightsReturnUrl" data-toggle="collapse" data-target=".method_getRightsReturnUrl .collapse" title="public">
<h2>Returns the URL that the user should be redirected to
after updating an authorization item.</h2>
<pre>getRightsReturnUrl(string $defaultUrl<code> = null</code>) : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$defaultUrl</h4>
<code>string</code><p>the default return URL in case it was not set previously. If this is null,
the application entry URL will be considered as the default return URL.</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>the URL that the user should be redirected to
after updating an authorization item.</div>
</div></div>
</div>
<a id="method_setIsSuperuser"></a><div class="element clickable method public method_setIsSuperuser" data-toggle="collapse" data-target=".method_setIsSuperuser .collapse" title="public">
<h2>setIsSuperuser()
        </h2>
<pre>setIsSuperuser(boolean $value) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$value</h4>
<code>boolean</code><p>whether the user is a superuser.</p></div>
</div></div>
</div>
<a id="method_setRightsReturnUrl"></a><div class="element clickable method public method_setRightsReturnUrl" data-toggle="collapse" data-target=".method_setRightsReturnUrl .collapse" title="public">
<h2>setRightsReturnUrl()
        </h2>
<pre>setRightsReturnUrl(array $value) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$value</h4>
<code>array</code><p>return url.</p></div>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br>
            generated on 2014-02-03T11:03:56-02:00.<br></footer></div>
</div>
</body>
</html>
